Introduction

This section describes how to setup your development environment.

Compiler: J2SE 1.4.2 SDK

The java files can be compiled using a Java compiler (SDK) and the class files can be run with a Java Virtual Machine (JVM). SGN requires Java 1.4 or higher.

We strongly recommend Sun's SDK for J2SE (version 1.4.2 or higher). SGN does NOT require J2EE or J2ME, as it is a normal desktop application. Sun's SDK is freely downloadable here.

After installation, your environment variables should contain the following:

  • JAVA_HOME set to the SDK home directory
  • PATH modified to contain the bin subdirectory of JAVA_HOME
In windows you can modify these variables permentatly (recommended) in Start/Control panel/System/Advanced/Environment variables. Open the command shell ( Start/Run cmd) and run java -?. You should get information on how to run the java command. Changes made in the control panel will only be reflected in newly openend command shells.

You can also view or set the environment variables temperoraly on the windows command shell with the SET command, for example: 

JAVA_HOME=C:\j2sdk1.4.2_03
PATH=C:\j2sdk1.4.2_03\bin;C:\Program Files\Apache\Maven 1.0\bin;C:\WINDOWS\system32;C:\WINDOWS

Build tool: Apache Maven 1.0

After the java files have been compiled, they need to be compressed, tested, uploaded, etc. Also the documentation needs to be generated (html and pdf), uploaded, etc. Maven automates all of this and much more.

Maven is freely downloadable here.

After installation, your environment variables should contain the following:

  • MAVEN_HOME set to the SDK home directory
  • PATH modified to contain the bin subdictory of MAVEN_HOME
Test this by opening the command shell and running maven -g. You should get a list of all available Maven goals.

Java IDE: IntelliJ IDEA 4.0 (or Eclipse)

A Java IDE is the visual enviroment to make it easier to write and debug Java code. SGN does not require a specific IDE. We prefer the commercial IntelliJ IDEA 4.0, but the free Eclipse is a very good alternative. For IntelliJ you 'll need a serial key, but you can get a temporary evaluation key.

IntelliJ is downloadable here. Eclipse is freely downloadable here.

During installation the IDE will ask you for your Java compiler home. Normally it should be defaulted to JAVA_HOME.

Both IDE's support CVS, which SGN uses through SourceForge's CVS server.

In both IDE's you need specific Maven support through an IDE plugin. In IntelliJ, open Settings/Plugins/Available/MavenPlugin and install ConsoleMavenPlugin. For Eclipse, get and install Mevenide.

Distribution: SourceForge

SourceForge (SF) provides us with several services, such as website hosting, CVS, forums, etc.

To become a member of our team, you 'll require a SF account and notify us of your username.

Take a look at our SourceForge project page with the top right link SourceForge.net Project Page. Or take a look at our CVS through a web interface, in the left menu Project Documentation/Project Info/Source Repository/Web Access.